docs: Add a note that label id is only required when updating label #2268
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lampajr
requested changes
Feb 17, 2025
There was a problem hiding this comment.
Hi @jhutar, thanks a lot for the PR and it looks great to me!
Unfortunately the OpenAPI spec is auto-generated during the build, therefore rather than doing the change there you should do it here
SchemaService definition. Then, if you run mvn clean install -DskipTest -DskipITs you will see the same changes reported on the OpenAPI specs
jhutar
force-pushed
the
fix1-label-id-not-required
branch
from
4d6e603 to
4a026c9
Compare
|
Thank you Andrea! Fixed that and used the Maven command you mentioned to regenerate that API docs. Hope it is OK now. |
lampajr
approved these changes
Feb 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes Issue
Looking into https://horreum.hyperfoil.io/openapi/#tag/Schema/operation/addOrUpdateLabel API doc says
id("Unique ID for Label") is required. This should be only required when you are updating label, not adding new one. It confused me.Changes proposed
Just a tiny docs change.